api/userSessions/{id} (Get)

Get	api/userSessions/{id}

In This Topic

Resource Path: /sites/{company-id}/api/userSessions/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/userSessions/{id}

Description

Retrieves a single UserSession object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of a UserSession as a Guid.	string

200 Response

The response body is of type UserSession.

Returns a comprehensive UserSession object.

UserSession

Represents a comprehensive UserSession record within the OnTime API.

Vehicle : string

The unique Guid identifier referencing the Vehicle operated by the User for the duration of this UserSession.

ID : string

The unique identifier for this UserSession record.

UserID : string

The unique Guid identifier referencing the relative User record assigned to this UserSession.

LogInType : string

Determines if the User is logged-in as a dispatcher or driver for the duration of this UserSession. Available Values: [Undefined, Dispatcher, Driver]

LogInTime : string

The date and time that the User had logged-out.

LogOutTime : string

The date and time that the User had logged-out.

StartMileage : integer

The initial odometer reading of the Vehicle when the User logged-in as a driver.

EndMileage : integer

The final odometer reading of the Vehicle when the User logged-out as a driver.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.